DIGILAB API (1.0.0)

License: MIT

API for managing manuscript, 3D models, textures, annotations, and poses in DIGILAB.

3d-annotations

All 3D Annotation related operations

Retrieve all 3D annotations

Authorizations:

bearerAuth

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=name,asc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `name,asc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema:
application/json

Array

region	string 3D region where the annotation applies
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"region": "string",
"annotation": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"model": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Create a new 3D annotation

Authorizations:

bearerAuth

Request Body schema: application/json

region	string 3D region where the annotation applies
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"region": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get a 3D annotation

Authorizations:

bearerAuth

path Parameters

annotationId

required

string

Responses

Response Schema: application/json

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace a 3D annotation

Authorizations:

bearerAuth

path Parameters

annotationId

required

string

Request Body schema: application/json

region	string 3D region where the annotation applies
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"region": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a 3D annotation

Authorizations:

bearerAuth

path Parameters

annotationId

required

string

Request Body schema: application/json

region	string 3D region where the annotation applies
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"region": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a 3D annotation

Authorizations:

bearerAuth

path Parameters

annotationId

required

string

Responses

3d-annotations/{id}/annotations

All Annotations related to a 3D Annotations

Get annotations of a 3D annotation

returns a list of annotations with support for pagination, sorting and multiple formats.

Authorizations:

bearerAuth

path Parameters

annotationId

required

string

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=createdDate,desc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `createdDate,desc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response Schema: application/json

error	string
supported_formats	Array of strings

Response samples

200
406

Content type

application/json

[{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add a new annotation to a 3D annotation

Authorizations:

bearerAuth

path Parameters

annotationId

required

string

Request Body schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get an annotation of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
annotationId required	string

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace an annotation of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
annotationId required	string

Request Body schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update an annotation of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
annotationId required	string

Request Body schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete an annotation of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
annotationId required	string

Responses

3d-annotations/{id}/3d-models

All 3D Models related operations

Get a 3D model of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
3dMoldeId required	string

Responses

Response Schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace a 3D model of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
3dMoldeId required	string

Request Body schema: application/json

name	string Name of the 3D model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a 3D model of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
3dMoldeId required	string

Request Body schema: application/json

name	string Name of the 3D model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a 3D model of a 3D annotation

Authorizations:

bearerAuth

path Parameters

3dAnnotationId required	string
3dMoldeId required	string

Responses

Annotations

All Annotation related operations

Get annotations

returns returns a list of annotations with support for pagination, sorting and multiple formats.

Authorizations:

bearerAuth

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=createdDate,desc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `createdDate,desc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response Schema: application/json

error	string
supported_formats	Array of strings

Response samples

200
406

Content type

application/json

[{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Create a new annotation

Authorizations:

bearerAuth

Request Body schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get an annotation

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace an annotation

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update an annotation

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete an annotation

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

events

All Events related operations

Get all events

This operation retrieves all events.

Authorizations:

bearerAuth

Responses

Response Schema: application/json

Array

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Create a new event

This operation creates a new event.

Authorizations:

bearerAuth

Request Body schema: application/json

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get an event

This operation retrieves an event based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema: application/json

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update an event

This operation updates an event based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete an event

This operation deletes an event based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Replace an event

This operation replaces an event based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

events/{id}/locations

All location related to event

Get Locations of an Event

Get locations of an Event.

Authorizations:

bearerAuth

path Parameters

eventId

required

string

query Parameters

id	Array of strings Filtra le location per ID, valori multipli separati da virgola ad es. `1,2,3`
name	string Filtra le location per nome
address	string Filtra le location per indirizzo
coordinates	Array of numbers Filtra le location per coordinate, valori separati da virgola ad es. `1.0,2.0`
identifiers	Array of strings Filtra i manoscritti per identificatore, valori multipli separati da virgola ad es. `1,2,3`
page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=name,asc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `name,asc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"id": "1",
"name": "Location 1",
"description": "Description 1",
"address": "Address 1",
"coordinates": [1,
2
]
},
{"id": "2",
"name": "Location 2",
"description": "Description 2",
"address": "Address 2",
"coordinates": [3,
4
]
}
]

Add Location to Event

Add a location to an event

Authorizations:

bearerAuth

path Parameters

eventId

required

string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get Location of an Event

Get a specific location by its ID

Authorizations:

bearerAuth

path Parameters

eventId required	string
locationId required	string

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update Location of an Event

Update a location of an event with new information

Authorizations:

bearerAuth

path Parameters

eventId required	string
locationId required	string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Patch Location of an Event

partial update a location with new information

Authorizations:

bearerAuth

path Parameters

eventId required	string
locationId required	string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete Location of an Event

Delete a location of an event. This operation deletes a specific location by its ID.

Authorizations:

bearerAuth

path Parameters

eventId required	string
locationId required	string

Responses

Illuminated Scene

All Illuminated Scene related operations

Retrieve all illuminated manuscript scenes

Authorizations:

bearerAuth

query Parameters

id	Array of strings Filtra illuminated manuscript scenes per ID, valori multipli separati da virgola ad es. `1,2,3`
title	string Filtra illuminated manuscript scenes per titolo
description	string Filtra illuminated manuscript scenes per descrizione
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Filtra illuminated manuscript scenes in base al loro stato: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato
locations	string Filtra illuminated manuscript scenes per nome location
locationId	Array of strings Filtra illuminated manuscript scenes per location ID, valori multipli separati da virgola ad es. `1,2,3`
authors	string Filtra illuminated manuscript scenes per nome autore
authorId	Array of strings filtra illuminated manuscript scenes per autore ID, valori multipli separati da virgola ad es. `1,2,3`
editors	string Filtra illuminated manuscript scenes per nome editor
editorId	Array of strings filtra illuminated manuscript scenes per editor ID, valori multipli separati da virgola ad es. `1,2,3`
identifiers	Array of strings Filtra illuminated manuscript scenes per identificatore, valori multipli separati da virgola ad es. `1,2,3`
page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=createdDate,desc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `createdDate,desc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Response samples

200

Content type

application/json

[{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}
]

Create a new illuminated manuscript scene

Authorizations:

bearerAuth

Request Body schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}

Retrieve a specific illuminated manuscript scene

Authorizations:

bearerAuth

path Parameters

id

required

string

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Pose) List of poses
	Array of objects (3DAnnotation) List of 3D annotations

Response samples

200

Content type

application/json

[{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations3D": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]
}
]

Update an entire illuminated manuscript scene

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}

Partially update an illuminated manuscript scene

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}

Delete an illuminated manuscript scene

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

3d annotations of an Illuminated Scene

3D Annotations related to Illuminated Scene

Get 3D annotations of an illuminated scene

returns a list of 3D annotations with support for pagination, sorting and multiple formats.

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=createdDate,desc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `createdDate,desc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response Schema: application/json

error	string
supported_formats	Array of strings

Response samples

200
406

Content type

application/json

[{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add a new 3D annotation to an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

Request Body schema: application/json

region	string 3D region where the annotation applies
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"region": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get a 3D annotation of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
3dAnnotationId required	string

Responses

Response Schema: application/json

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace a 3D annotation of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
3dAnnotationId required	string

Request Body schema: application/json

region	string 3D region where the annotation applies
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"region": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a 3D annotation of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
3dAnnotationId required	string

Request Body schema: application/json

region	string 3D region where the annotation applies
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"region": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a 3D annotation of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
3dAnnotationId required	string

Responses

Poses of an Illuminated Scene

Poses related to Illuminated Scene

Get poses of an illuminated scene

returns a list of poses with support for pagination, sorting and multiple formats.

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=createdDate,desc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `createdDate,desc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response Schema: application/json

error	string
supported_formats	Array of strings

Response samples

200
406

Content type

application/json

[{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add a new pose to an illuminated

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

Request Body schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get a pose of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
poseId required	string

Responses

Response Schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace a pose of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
poseId required	string

Request Body schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a pose of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
poseId required	string

Request Body schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a pose of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
poseId required	string

Responses

Authors of an Illuminated Scene

Authors related to Illuminated Scene

Get authors of an illuminated scene

returns a list of authors with support for pagination, sorting and multiple formats.

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=createdDate,desc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `createdDate,desc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response Schema: application/json

error	string
supported_formats	Array of strings

Response samples

200
406

Content type

application/json

[{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add a new author to an illuminated

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get an author of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
authorId required	string

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace an author of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
authorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update an author of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
authorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete an author of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
authorId required	string

Responses

Editors of an Illuminated Scene

Editors related to Illuminated Scene

Get editors of an illuminated scene

returns a list of editors with support for pagination, sorting and multiple formats.

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=createdDate,desc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `createdDate,desc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle.

Responses

Response Schema:
application/json

Array

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response Schema: application/json

error	string
supported_formats	Array of strings

Response samples

200
406

Content type

application/json

[{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add a new editor to an

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId

required

string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get an editor of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
editorId required	string

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace an editor of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
editorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update an editor of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
editorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete an editor of an illuminated scene

Authorizations:

bearerAuth

path Parameters

illuminatedSceneId required	string
editorId required	string

Responses

Locations

All Locations related operations

Get Locations

Get all locations. This operation retrieves all the available locations.

Authorizations:

bearerAuth

query Parameters

id	Array of strings Filtra le location per ID, valori multipli separati da virgola ad es. `1,2,3`
name	string Filtra le location per nome
address	string Filtra le location per indirizzo
coordinates	Array of numbers Filtra le location per coordinate, valori separati da virgola ad es. `1.0,2.0`
identifiers	Array of strings Filtra i manoscritti per identificatore, valori multipli separati da virgola ad es. `1,2,3`
page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=name,asc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `name,asc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"id": "1",
"name": "Location 1",
"description": "Description 1",
"address": "Address 1",
"coordinates": [1,
2
]
},
{"id": "2",
"name": "Location 2",
"description": "Description 2",
"address": "Address 2",
"coordinates": [3,
4
]
}
]

Create Location

Create a new location with the specified details

Authorizations:

bearerAuth

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get Location

Get a specific location by its ID

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update Location

Update a location with new information

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Patch Location

partial update a location with new information

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete Location

Delete a location. This operation deletes a specific location by its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Manuscripts

All Manuscripts related operations

Get all manuscripts

This operation retrieves all manuscripts.

Authorizations:

bearerAuth

query Parameters

id	Array of strings Filtra i manoscritti per ID, valori multipli separati da virgola ad es. `1,2,3`
title	string Filtra i manoscritti per titolo
description	string Filtra i manoscritti per descrizione
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Filtra i manoscritti in base al loro stato: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato
locations	string Filtra i manoscritti per nome location
locationId	Array of strings Filtra i manoscritti per location ID, valori multipli separati da virgola ad es. `1,2,3`
authors	Array of strings Filtra i manoscritti per nome autore
authorId	Array of strings
editorId	Array of strings Filtra i manoscritti per ID dell'editore, valori multipli separati da virgola ad es. `1,2,3`
identifiers	Array of strings Filtra i manoscritti per identificatore, valori multipli separati da virgola ad es. `1,2,3`
page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=name,asc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `name,asc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

required

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Response samples

200

Content type

application/json

[{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}
]

Create a new manuscript

This operation creates a new manuscript.

Authorizations:

bearerAuth

Request Body schema: application/json

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Responses

Response Schema: application/json

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Request samples

Payload

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}

Response samples

201

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}

Get a manuscript

This operation retrieves a manuscript based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema:
application/json

title	string
description	string
creationDate	string <date-time>
publicationDate	string <date-time>
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Location)
	Array of objects (LighContent)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (LightIlluminatedScene)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"title": "string",
"description": "string",
"creationDate": "2019-08-24T14:15:22Z",
"publicationDate": "2019-08-24T14:15:22Z",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"illuminated-scenes": [{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}
],
"status": "draft",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a manuscript

This operation updates a manuscript based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Responses

Response Schema: application/json

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Request samples

Payload

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}

Response samples

200

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}

Delete a manuscript

This operation deletes a manuscript based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Replace a manuscript

This operation replaces a manuscript based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Responses

Response Schema: application/json

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Request samples

Payload

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}

Response samples

200

Content type

application/json

{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}

Contents of a Manuscript

All Manuscript Contents related operations

Ottiene tutti i contenuti di un manoscritto

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID del manoscritto

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Response samples

200

Content type

application/json

[{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}
]

Aggiunge un nuovo contenuto a un manoscritto

Authorizations:

bearerAuth

path Parameters

id

required

integer

ID del manoscritto

Request Body schema: application/json

intro	string
category required	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content required	string

Responses

Response Schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Request samples

Payload

Content type

application/json

{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}

Response samples

201

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Aggiorna un contenuto specifico di un manoscritto

Authorizations:

bearerAuth

path Parameters

manuscriptId required	integer ID del manoscritto
contentId required	integer ID del contenuto

Request Body schema: application/json

intro	string
category required	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content required	string

Responses

Response Schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Request samples

Payload

Content type

application/json

{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}

Response samples

200

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Elimina un contenuto di un manoscritto

Authorizations:

bearerAuth

path Parameters

manuscriptId required	integer ID del manoscritto
contentId required	integer ID del contenuto

Responses

Locations of a Manuscript

Locations related to Manuscript

Get locations of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId

required

string

Responses

Response Schema: application/json

Array

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add location to manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId

required

string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get location of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
locationId required	string

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update location of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
locationId required	string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Patch location of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
locationId required	string

Request Body schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete location of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
locationId required	string

Responses

Authors of a Manuscript

Authors related to Manuscript

Get authors of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId

required

string

Responses

Response Schema: application/json

Array

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Get author of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
authorId required	string

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update author of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
authorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Patch author of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
authorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Remove author from manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
authorId required	string

Responses

Editors of a Manuscript

Editors related to Manuscript

Get editors of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId

required

string

Responses

Response Schema: application/json

Array

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add editor to manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId

required

string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get editor of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
editorId required	string

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update editor of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
editorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Patch editor of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
editorId required	string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Remove editor from manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
editorId required	string

Responses

Illuminated Scenes of a Manuscript

Illuminated Scenes related to Manuscript

Get illuminated scenes of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId

required

string

Responses

Response Schema: application/json

Array

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Pose) List of poses
	Array of objects (3DAnnotation) List of 3D annotations

Response samples

200

Content type

application/json

[{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations3D": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]
}
]

Add illuminated scene to manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId

required

string

Request Body schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Pose) List of poses
	Array of objects (3DAnnotation) List of 3D annotations

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations3D": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]
}

Get illuminated scene of a manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
illuminatedSceneId required	string

Responses

Response Schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Response samples

200

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}

Update illuminated scene of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
illuminatedSceneId required	string

Request Body schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Responses

Response Schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Pose) List of poses
	Array of objects (3DAnnotation) List of 3D annotations

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}

Response samples

200

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations3D": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]
}

Patch illuminated scene of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
illuminatedSceneId required	string

Request Body schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Responses

Response Schema: application/json

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Pose) List of poses
	Array of objects (3DAnnotation) List of 3D annotations

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}

Response samples

200

Content type

application/json

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations3D": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]
}

Delete illuminated scene of manuscript

Authorizations:

bearerAuth

path Parameters

manuscriptId required	string
illuminatedSceneId required	string

Responses

Persons

All Persons related operations

Create Person

Create a new person with the given information

Authorizations:

bearerAuth

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get persons

Get all persons

Authorizations:

bearerAuth

Responses

Response Schema: application/json

Array

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Get a specific person

Get a person . This operation retrieves a specific person by their ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace a person

Replace a person with new information

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Patch a person

Update a person . This operation updates a person's information based on their ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a person

Delete a person . This operation deletes a person based on their ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Poses

All Pose related operations

Retrieve all poses

Authorizations:

bearerAuth

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=name,asc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `name,asc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema:
application/json

Array

name	string Name of the pose
	Array of objects (Reference) List of 3D models associated with the pose
	Array of objects (Reference)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"name": "string",
"models": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"contents": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Create a new pose

Authorizations:

bearerAuth

Request Body schema: application/json

name	string Name of the pose
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get a pose

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace a pose

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

name	string Name of the pose
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a pose

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

name	string Name of the pose
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a pose

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

tagPoses/{id}/3d-models

Get 3D models of a pose

Authorizations:

bearerAuth

path Parameters

poseId

required

string

Responses

Response Schema: application/json

Array

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add 3D model to pose

Authorizations:

bearerAuth

path Parameters

poseId

required

string

Request Body schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get 3D model of a pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
3dModelId required	string

Responses

Response Schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update 3D model of pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
3dModelId required	string

Request Body schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Patch 3D model of pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
3dModelId required	string

Request Body schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete 3D model of pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
3dModelId required	string

Responses

tagPoses/{id}/contents

Get contents of a pose

Authorizations:

bearerAuth

path Parameters

poseId

required

string

Responses

Response Schema: application/json

Array

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Response samples

200

Content type

application/json

[{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}
]

Add content to pose

Authorizations:

bearerAuth

path Parameters

poseId

required

string

Request Body schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Get content of a pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
contentId required	string

Responses

Response Schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Response samples

200

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Update content of pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
contentId required	string

Request Body schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Responses

Response Schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Request samples

Payload

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Response samples

200

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Patch content of pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
contentId required	string

Request Body schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Responses

Response Schema: application/json

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

Request samples

Payload

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Response samples

200

Content type

application/json

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

Delete content of pose

Authorizations:

bearerAuth

path Parameters

poseId required	string
contentId required	string

Responses

Projects

All Projects related operations

Create a new project

This operation creates a new project.

Authorizations:

bearerAuth

Request Body schema: application/json

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

201

Content type

application/json

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get all projects

This operation retrieves all projects.

Authorizations:

bearerAuth

Responses

Response Schema: application/json

Array

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Get a project

This operation retrieves a project based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema: application/json

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a project

This operation updates a project based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a project

This operation deletes a project based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Replace a project

This operation replaces a project based on its ID.

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Texture

All Texture related operations

Retrieve all textures

Authorizations:

bearerAuth

query Parameters

page	integer >= 0 Default: 0 Numero della pagina (facoltativo, predefinito: 0). L'indice parte da 0.
size	integer >= 1 Default: 20 Numero di elementi per pagina (facoltativo, predefinito: 20). Deve essere maggiore di 0.
sort	string Example: sort=name,asc Campo per l'ordinamento (facoltativo). Formato: `campo,direzione` (es. `name,asc`). Direzioni supportate: `asc`, `desc`.

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

[{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]

Add a texture to a 3D model

Authorizations:

bearerAuth

Request Body schema: application/json

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Request samples

Payload

Content type

application/json

{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Get a texture

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Response Schema: application/json

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Response samples

200

Content type

application/json

{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Replace a texture

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Update a texture

Authorizations:

bearerAuth

path Parameters

id

required

string

Request Body schema: application/json

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Responses

Response Schema: application/json

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

Request samples

Payload

Content type

application/json

{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Response samples

200

Content type

application/json

{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Delete a texture

Authorizations:

bearerAuth

path Parameters

id

required

string

Responses

Authors

All Author related operations

Get all manuscripts of an author

This operation retrieves all manuscripts for an author.

Authorizations:

bearerAuth

path Parameters

id

required

string

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Response samples

200

Content type

application/json

[{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}
]

Editors

All editors related operations

Get all manuscripts of an editor

This operation retrieves all manuscripts of am editor.

Authorizations:

bearerAuth

path Parameters

id

required

string

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

Response samples

200

Content type

application/json

[{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}
]

Get all scenes of an editor

This operation retrieves all scenes for an editor.

Authorizations:

bearerAuth

path Parameters

id

required

string

header Parameters

Accept

string

Enum: "application/json" "text/turtle"

Formato di risposta desiderato. Valori supportati: application/json, text/turtle

Responses

Response Schema: application/json

Array

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

Response samples

200

Content type

application/json

[{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}
]

API Reference

Reference

Una reference da una risorsa a un'altra

reference required	string Literal reference, URL relativa, interna o assoluta
type	string <uri> Tipo della risorsa a cui fa riferimento (es. "Patient")
	object Riferimento logico quando non si conosce il riferimento letterale
display	string Testo alternativo per la risorsa

{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}

Base Entity

id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Location

A location object extending the Base Entity

name	string
description	string
address	string
coordinates	Array of numbers = 2 items
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Person

A person object extending the Base Entity

firstName required	string The person's first name
lastName required	string The person's last name
department required	string The person's department
birthDate	string <date> The person's birthDate
deathDate	string <date> The person's deathDate
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"firstName": "string",
"lastName": "string",
"department": "string",
"birthDate": "2019-08-24",
"deathDate": "2019-08-24",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Project

A project object extending the Base Entity

	object (Period)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"periods": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Event

An event object extending the Base Entity

type	string
	object (Period)
	object (Location)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"type": "string",
"Period": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"Location": {"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Manuscript

A manuscript object extending the Base Entity

title	string
description	string
creationDate	string <date-time>
publicationDate	string <date-time>
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Location)
	Array of objects (LighContent)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (LightIlluminatedScene)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"title": "string",
"description": "string",
"creationDate": "2019-08-24T14:15:22Z",
"publicationDate": "2019-08-24T14:15:22Z",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"name": "string",
"description": "string",
"address": "string",
"coordinates": [0,
0
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"illuminated-scenes": [{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}
],
"status": "draft",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Light Manuscript

A Light manuscript object

id	string
title	string
description	string
previewImage	string <uri>
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
	Array of objects (Reference)
status	string Enum: "draft" "in_review" "revisions_required" "accepted" "in_editing" "published" "rejected" "withdrawn" Stato attuale del manoscritto: `draft`: Bozza `in_review`: In revisione `revisions_required`: Revisione necessaria `accepted`: Accettato `in_editing`: In fase di editing `published`: Pubblicato `rejected`: Rifiutato `withdrawn`: Ritirato

{"id": "string",
"title": "string",
"description": "string",
"previewImage": "http://example.com",
"events": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"projects": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"locations": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"scenes": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"status": "draft"
}

Illuminated Scene

An illuminated manuscript scene object extending the Base Entity

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Pose) List of poses
	Array of objects (3DAnnotation) List of 3D annotations

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations3D": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
]
}

Light Illuminated Scene

A light illuminated manuscript scene object

title	string Title of the scene
description	string Description of the scene
panorama	string <uri> Panoramic view of the scene
previewImage	string <uri> Preview image of the scene
	Array of objects (Reference) List of authors of the scene
	Array of objects (Reference) List of editors
visibility	string Enum: "public" "private" "restricted" Visibility status of the scene
	object (Reference) Una reference da una risorsa a un'altra
	object (Reference) Una reference da una risorsa a un'altra
	Array of objects (Reference) List of poses
	Array of objects (Reference) List of 3D annotations

{"title": "string",
"description": "string",
"panorama": "http://example.com",
"previewImage": "http://example.com",
"authors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"editors": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"visibility": "public",
"project": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"manuscript": {"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
},
"poses": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
],
"annotations3D": [{"reference": "Risorsa/1234",
"type": "Risorsa",
"identifier": {"system": "http://digilab.com/risorsa-ids",
"value": "1234"
},
"display": "descrizione della risorsa"
}
]
}

Pose

A pose object extending the Base Entity

name	string Name of the pose
	Array of objects (3DModel) List of 3D models associated with the pose
	Array of objects (LighContent)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"name": "string",
"3d-models": [{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"contents": [{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Texture

A texture object extending the Base Entity

type	string Enum: "RGB" "IR1" "IR2" "UV" Texture type (RGB, IR1, IR2, UV)
fileUrl	string <uri> URL of the texture image
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

3D Model

A 3D model object extending the Base Entity

name	string Name of the 3D model
	Array of objects (Texture) List of textures associated with the 3D model
	Array of objects (3DAnnotation) List of 3D annotations linked to the model
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": { },
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Annotation

An annotation object extending the Base Entity

type	string Enum: "text" "image" "video" "audio" Annotation type (text, image, video, audio)
content	string Content of the annotation (text, image URL, video URL, audio URL)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

3d Annotation

A 3D annotation object extending the Base Entity

region	string 3D region where the annotation applies
	object (Annotation)
	object (3DModel)
id	string Unique identifier for the object. It could not be send in POST
	Array of objects (Identifier)
	Array of objects (Extension)

{"region": "string",
"annotation": {"type": "text",
"content": "string",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"model": {"name": "string",
"textures": [{"type": "RGB",
"fileUrl": "http://example.com",
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}
],
"annotations": [{ }
],
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
},
"id": "string",
"identifiers": [{"type": "string",
"standard": "string",
"value": "string"
}
],
"extensions": [{"uri": "string",
"value": "string"
}
]
}

Content

A content object extending the Base Entity

id	integer
manuscript_id	integer
intro	string
category	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content	string
last_updated	string <date-time>

{"id": 1,
"manuscript_id": 1,
"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"last_updated": "2021-09-01T12:00:00Z"
}

LighContent

A content input object

intro	string
category required	string Enum: "Storia e contesto" "Struttura e scrittura" "Materiali e tecniche esecutive" "Iconografia e iconologia" "Censure e modifiche" "Conservazione e restauro" "Bibliografia"
content required	string

{"category": "Storia e contesto",
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}

DIGILAB API (1.0.0)

3d-annotations

Retrieve all 3D annotations

Authorizations:

query Parameters

header Parameters

Responses

Response Schema: application/jsontext/turtleapplication/json

Response samples

Create a new 3D annotation

Authorizations:

Request Body schema: application/json

Responses

Request samples

Get a 3D annotation

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Replace a 3D annotation

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Update a 3D annotation

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Delete a 3D annotation

Authorizations:

path Parameters

Responses

3d-annotations/{id}/annotations

Get annotations of a 3D annotation

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response Schema: application/jsontext/turtleapplication/json

Response Schema: application/json

Response samples

Add a new annotation to a 3D annotation

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Get an annotation of a 3D annotation

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Replace an annotation of a 3D annotation

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Update an annotation of a 3D annotation

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Response Schema: application/json

Request samples

Response samples

Response Schema:
application/json

Response Schema:
application/json

Response Schema:
application/json